Add missing blocking argument documentation to the external source operator
#5501
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…operator - as the external source operator documentation is written in Python, it missed the `blocking` argument description which was defined in the native schema but not copied to the python description Signed-off-by: Janusz Lisiecki <jlisiecki@nvidia.com>
|
!build |
|
CI MESSAGE: [15587657]: BUILD STARTED |
jantonguirao
approved these changes
Jun 5, 2024
mzient
reviewed
Jun 5, 2024
Comment on lines
463
to
466
| `blocking`: bool, optional | ||
| If True, this operator will block until the data is available | ||
| (e.g. by calling ``feed_input``). If False, the operator will raise an error, | ||
| if the data is not available. |
There was a problem hiding this comment.
I would add some warning that it's intended for advanced usage.
Suggested change
| `blocking`: bool, optional | |
| If True, this operator will block until the data is available | |
| (e.g. by calling ``feed_input``). If False, the operator will raise an error, | |
| if the data is not available. | |
| `blocking`: bool, optional | |
| **Advanced** if True, this operator will block until the data is available | |
| (e.g. by calling ``feed_input``). If False, the operator will raise an error, | |
| if the data is not available. |
There was a problem hiding this comment.
Fixed here and in the input op.
Signed-off-by: Janusz Lisiecki <jlisiecki@nvidia.com>
|
!build |
mzient
approved these changes
Jun 5, 2024
|
CI MESSAGE: [15590147]: BUILD STARTED |
|
CI MESSAGE: [15587657]: BUILD PASSED |
|
!build |
|
CI MESSAGE: [15592614]: BUILD STARTED |
|
CI MESSAGE: [15590147]: BUILD PASSED |
|
CI MESSAGE: [15592614]: BUILD PASSED |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
in Python, it missed the
blockingargument descriptionwhich was defined in the native schema but not copied to
the python description
Category:
Other (e.g. Documentation, Tests, Configuration)
Description:
Additional information:
Affected modules and functionalities:
Key points relevant for the review:
Tests:
Checklist
Documentation
DALI team only
Requirements
REQ IDs: N/A
JIRA TASK: N/A